Payment Management Biz API icon

Payment Management Biz API

1.0.x
(0 reviews)

PA Market

POST /payment Key considerations For Panama Postpaid/Fixed

  1. The implementation to create the payment is available for types Order, Deposit and Batch.
  2. We should consider Order and Batch for Billpayments.
  3. This posts the payment to liberate for Panama market which includes Fixed and Postpaid as BSS is liberate
  4. For remaining flow markets, payment is posted to liberate/cerillion based on account number length.
  5. The PaymentMethod which we are giving in Input should be configured at Liberate Side.

  6. Below are some of the sample payment methods configured for Panama

    • CASH=C
    • CHECK=Q
    • CREDIT_CARD=R
    • AMEX_CREDIT_CARD=W
    • CLAVE=S
    • DEBIT_CARD=X

  7. The Value for PaymentItem[X].item.id should be matched with the Deposit Requirement Id to make any deposits for referredType "Deposit"(For Panama CareApp Migration "Deposit Payment" is not in the Scope as the enabler PAN-2332 only covers BillPayment).

  8. Channel.id is considered as a CashierId.

Request

This section defines all the possible data structures sent by the client when consuming the method.

URL

http://[localhost]:[port]/tmf-api/paymentManagement/v4/{businessId}/payment

URL PARAMS

nametypedescriptionrequired
businessIdstring2 letter ISO 3166 country code (TT, BB, JM, PA, PR, CR etc.) identifying the business unit.Y
namevaluedescriptionrequired
client_idstringThe client_id identifying the channel. Minimum characters: 5Y
client_secretstringPassword associated with the client_id. Minimum characters: 5Y
X-Correlation-IDstringAn identifier for the current call chain that can be used to tie together log entries on multiple layers (e.g. client, server, mainframe). This identifier must be designed to be unique across all applications.
pattern: ^[a-zA-Z0-9-+/=_]{16,64}$
minLength: 16
maxLength: 64		N
Locationstringspecify the URI of a newly created resource and may be used to direct clients to the operational status of an asynchronous controller resource
RFC 7231: Hypertext Transfer Protocol (HTTP/1.1): Semantics and Content (rfc-editor.org)		N
PreferstringUsed to indicate that particular server behaviors are preferred by the client.
enum:
respond-async: indicates that the client prefers the server to respond asynchronously to a response
return=representation: Indicates that the client prefers that the server include an entity representing the current state of the resource in the response to a successful request.
return=minimal: Indicates that the client wishes the server to return only a minimal response to a successful request
RFC 7240: Prefer Header for HTTP (rfc-editor.org)		N

Request Body

NOTE: Reference is in RAML (/payment POST)

Response

In this section all the possible data structures received by the client at the moment of responding the method are defined.

Possible response success

This section defines all the possible data structures received by the client and that must be considered satisfactory at the time of responding to the method.

[ 201 ]

Created - request successful, createPayment has been created. Response body may contain an entity corresponding to the created resource.

NOTE: Reference is in RAML (/payment POST)

Possible response error

In this section all the possible data structures received by the client are defined and that must be considered as unsatisfactory when responding to the method.

[ 400 ]

Bad Request - If the customer provides a payment method which is not configured at Liberate side.

{
  "correlatorId": "CWP-03302023-003",
  "account": {
    "id": "148019330000"
  },
  "paymentItem": [
    {
      "totalAmount": {
        "amount": 0.01
      },
      "item": {
        "referredType": "Order",
        "id": "error",
        "description": "PAYMETHNOTFND-Payment method not found."
      }
    }
  ]
}

####

Bad request- For the Deposit Request, if the given Deposit Number is not in sync with Liberate then we will get the below Error.

{
  "correlatorId": "31012073244110",
  "account": {
    "id": "329064930000"
  },
  "paymentItem": [
    {
      "totalAmount": {
        "amount": 1.45
      },
      "item": {
        "referredType": "Deposit",
        "id": "error",
        "description": "Validation constraint violation: data type mismatch  in element 'ns1:depositReqtNo'"
      }
    }
  ]
}

####

Error when the Liberate recieves a request with invalid employeeId (Value given in ChannelId).

{
  "correlatorId": "31012073244110",
  "account": {
    "id": "329064930000"
  },
  "paymentItem": [
    {
      "totalAmount": {
        "amount": 1.45
      },
      "item": {
        "referredType": "Order",
        "id": "error",
        "description": "Current Cashdrawer not found for specified cashier"
      }
    }
  ]
}

####

##

Reviews